Skip to content

Add hide_api_docs config option to hide API documentation on the web UI#51

Open
SaschaWeller wants to merge 4 commits intosameerdhoot:mainfrom
SaschaWeller:feature/hide-api-docs
Open

Add hide_api_docs config option to hide API documentation on the web UI#51
SaschaWeller wants to merge 4 commits intosameerdhoot:mainfrom
SaschaWeller:feature/hide-api-docs

Conversation

@SaschaWeller
Copy link

Summary

  • Adds a new hide_api_docs boolean config option (default: false) that hides the API documentation section on the web UI when set to true
  • Exposes the option as environment variable WOLWEBHIDEAPIDOCS for consistency with all other config options
  • Adds the variable as a build ARG and runtime ENV to both Dockerfiles (Alpine and Debian) and as a commented-out entry in docker-compose.yml

Changed files

File Change
types.go New HideAPIDocs field on AppConfig with JSON tag and env var
pages.go Pass HideAPIDocs into the HTML template data
index.html Wrap API docs section and its JS in {{ if not .HideAPIDocs }}
Dockerfile Add ARG/ENV for WOLWEBHIDEAPIDOCS
Debian_Dockerfile Add ARG/ENV for WOLWEBHIDEAPIDOCS
docker-compose.yml Add commented-out WOLWEBHIDEAPIDOCS env var entry
README.md Document the new option in the config table, JSON example, and env var table

Test plan

  • Run with "hide_api_docs": false (default) — API docs section visible as before
  • Run with "hide_api_docs": true — API docs section and related JS are not rendered
  • Run with WOLWEBHIDEAPIDOCS=true environment variable — same result, env var takes precedence over config file

SaschaWeller and others added 4 commits March 20, 2026 08:45
…bsite

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant